curl --request POST \
  --url https://{tenant_name}.{region}.techwolf.ai/employees/{employee_external_id}/jobs/{job_external_id}/recommended_courses \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "filters": [
    {
      "filter": "last_updated",
      "value": "2022-01-01",
      "operator": "lt"
    },
    {
      "filter": "custom_property_equal",
      "from_entity_property": "desired_wage",
      "to_entity_property": "wage"
    },
    {
      "filter": "custom_property",
      "property_name": "direct_manager",
      "property_value": "John Doe"
    },
    {
      "filter": "custom_property_is_in",
      "from_entity_property": "required_drivers_license",
      "to_entity_property": "drivers_licenses"
    },
    {
      "filter": "custom_property_is_in_list",
      "property_name": "drivers_license",
      "possible_values": [
        "C",
        "CE"
      ]
    },
    {
      "filter": "custom_property_contains",
      "from_entity_property": "shift_regime_codes",
      "to_entity_property": "desired_regime"
    },
    {
      "filter": "custom_property_list_overlap",
      "from_entity_property": "desired_industries",
      "to_entity_property": "industries"
    },
    {
      "filter": "custom_property_contains_element",
      "property_name": "industries",
      "property_value": "electronics"
    },
    {
      "filter": "external_id_is_in_list",
      "external_ids": [
        "c350500-eb84-42dc-a79f-5e7b1fe897b7",
        "b450500-eb84-42dc-a79f-5e7b1fe897c8"
      ]
    }
  ],
  "weights": [
    {
      "weight": "skills_match",
      "value": 1
    }
  ]
}'
{
  "results": [
    {
      "addressable_score": 0.8,
      "external_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
employee_external_id
string
required

Unique external ID linked to this Employee, consisting of alphanumeric characters, hyphens and underscores.

Required string length: 1 - 100
​
job_external_id
string
required

Unique external ID linked to this Job, consisting of alphanumeric characters, hyphens and underscores.

Required string length: 1 - 100

Query Parameters

​
limit
integer
default:
10

The maximal number of results returned.

Required range: 1 < x < 100
​
response_format
enum<string>
default:
simple

If set to explained, the response will include an explanation of the recommendation.

Available options:
simple,
explained
​
use_adjacent_skills
boolean
default:
true

If set to true, Course recommendations will consider adjacent Skills in addition to literal Skill overlap. If set to false, recommendations will be based solely on literal Skill overlap.

​
include
enum<string>[]

Additional entity attributes that will be included in the response body. This query parameter can be added multiple times to include more attributes. When include entity is used, the response will include the titles and descriptions of the recommended Courses.

Available options:
custom_properties,
entity

Body

application/json

List of filters to be applied on the entities before matching

​
filters
object[]
required
​
weights
object[]
required

List of weights to be applied during matching. Currently, Skills match weight is the only supported weight for Job matching and is set to 1.0 by default.

Response

200
application/json
OK
​
results
object[]
required

List of match results.

Was this page helpful?